<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Over The Air (OTA) Update Library: cy_ota_storage_context_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="infineon_logo.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Over The Air (OTA) Update Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Home</span></a></li>
      <li><a href="modules.html"><span>API&#160;Reference</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)"
               onblur="searchBox.OnSearchFieldFocus(false)"
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('structcy__ota__storage__context__t.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">cy_ota_storage_context_t Struct Reference<div class="ingroups"><a class="el" href="group__group__ota__structures.html">OTA Structures</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<div class="textblock"><p>OTA Agent storage context parameters structure. </p>
<p>These parameters are for describing some storage aspects of the OTA Agent. </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a259e6237fba59942fda5722f40a91b04"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a259e6237fba59942fda5722f40a91b04"></a>
void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__storage__context__t.html#a259e6237fba59942fda5722f40a91b04">storage_loc</a></td></tr>
<tr class="memdesc:a259e6237fba59942fda5722f40a91b04"><td class="mdescLeft">&#160;</td><td class="mdescRight">can be cast as flash_area or FILE as needed <br /></td></tr>
<tr class="separator:a259e6237fba59942fda5722f40a91b04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42cb555a74471636ac7e08bfabfc7386"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42cb555a74471636ac7e08bfabfc7386"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__storage__context__t.html#a42cb555a74471636ac7e08bfabfc7386">total_image_size</a></td></tr>
<tr class="memdesc:a42cb555a74471636ac7e08bfabfc7386"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total size of OTA Image. <br /></td></tr>
<tr class="separator:a42cb555a74471636ac7e08bfabfc7386"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affd4770ac434c4a78707f1182af30f09"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="affd4770ac434c4a78707f1182af30f09"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__storage__context__t.html#affd4770ac434c4a78707f1182af30f09">total_bytes_written</a></td></tr>
<tr class="memdesc:affd4770ac434c4a78707f1182af30f09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of bytes written to FLASH. <br /></td></tr>
<tr class="separator:affd4770ac434c4a78707f1182af30f09"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a719130f57cf7b026d9dab27bf0e70e9f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a719130f57cf7b026d9dab27bf0e70e9f"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__storage__context__t.html#a719130f57cf7b026d9dab27bf0e70e9f">last_offset</a></td></tr>
<tr class="memdesc:a719130f57cf7b026d9dab27bf0e70e9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Last offset written to from cy_ota_storage_write() <br /></td></tr>
<tr class="separator:a719130f57cf7b026d9dab27bf0e70e9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa333a651ad779e0f11ffbb6141c0af1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa333a651ad779e0f11ffbb6141c0af1"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__storage__context__t.html#aaa333a651ad779e0f11ffbb6141c0af1">last_size</a></td></tr>
<tr class="memdesc:aaa333a651ad779e0f11ffbb6141c0af1"><td class="mdescLeft">&#160;</td><td class="mdescRight">last size of data written from cy_ota_storage_write() <br /></td></tr>
<tr class="separator:aaa333a651ad779e0f11ffbb6141c0af1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19c4b2aa961f28ff70d258f81e177e3a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a19c4b2aa961f28ff70d258f81e177e3a"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__storage__context__t.html#a19c4b2aa961f28ff70d258f81e177e3a">last_packet_received</a></td></tr>
<tr class="memdesc:a19c4b2aa961f28ff70d258f81e177e3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Last Packet of data we have received. <br /></td></tr>
<tr class="separator:a19c4b2aa961f28ff70d258f81e177e3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cd89ab8a0eef15ae85ea44c7d255235"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9cd89ab8a0eef15ae85ea44c7d255235"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__storage__context__t.html#a9cd89ab8a0eef15ae85ea44c7d255235">total_packets</a></td></tr>
<tr class="memdesc:a9cd89ab8a0eef15ae85ea44c7d255235"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total number of Packets of data for the OTA Image. <br /></td></tr>
<tr class="separator:a9cd89ab8a0eef15ae85ea44c7d255235"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa92219aaeaa7dfd013a3bb625c9d2cd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa92219aaeaa7dfd013a3bb625c9d2cd"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__storage__context__t.html#aaa92219aaeaa7dfd013a3bb625c9d2cd">num_packets_received</a></td></tr>
<tr class="memdesc:aaa92219aaeaa7dfd013a3bb625c9d2cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total number of Packets received. <br /></td></tr>
<tr class="separator:aaa92219aaeaa7dfd013a3bb625c9d2cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d53b77a591716a65d39c2d3f77aba77"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1d53b77a591716a65d39c2d3f77aba77"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__storage__context__t.html#a1d53b77a591716a65d39c2d3f77aba77">last_num_packets_received</a></td></tr>
<tr class="memdesc:a1d53b77a591716a65d39c2d3f77aba77"><td class="mdescLeft">&#160;</td><td class="mdescRight">last time we saw how many were received, per-packet timer <br /></td></tr>
<tr class="separator:a1d53b77a591716a65d39c2d3f77aba77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a757e5841dc9491d7b2713439a0226417"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a757e5841dc9491d7b2713439a0226417"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__storage__context__t.html#a757e5841dc9491d7b2713439a0226417">ota_is_tar_archive</a></td></tr>
<tr class="memdesc:a757e5841dc9491d7b2713439a0226417"><td class="mdescLeft">&#160;</td><td class="mdescRight">!=0, this is a tar file <br /></td></tr>
<tr class="separator:a757e5841dc9491d7b2713439a0226417"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4dc6570c5b5e7123e4055388083fea81"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__storage__context__t.html#a4dc6570c5b5e7123e4055388083fea81">reboot_upon_completion</a></td></tr>
<tr class="memdesc:a4dc6570c5b5e7123e4055388083fea81"><td class="mdescLeft">&#160;</td><td class="mdescRight">1 = Automatically reboot upon download completion and verify.  <a href="#a4dc6570c5b5e7123e4055388083fea81">More...</a><br /></td></tr>
<tr class="separator:a4dc6570c5b5e7123e4055388083fea81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff1ac4aa0f0ac68c35d958366d9d7b29"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__ota__storage__context__t.html#aff1ac4aa0f0ac68c35d958366d9d7b29">validate_after_reboot</a></td></tr>
<tr class="memdesc:aff1ac4aa0f0ac68c35d958366d9d7b29"><td class="mdescLeft">&#160;</td><td class="mdescRight">0 = OTA will set upgrade image as permanent before reboot.  <a href="#aff1ac4aa0f0ac68c35d958366d9d7b29">More...</a><br /></td></tr>
<tr class="separator:aff1ac4aa0f0ac68c35d958366d9d7b29"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a4dc6570c5b5e7123e4055388083fea81"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t cy_ota_storage_context_t::reboot_upon_completion</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>1 = Automatically reboot upon download completion and verify. </p>

</div>
</div>
<a class="anchor" id="aff1ac4aa0f0ac68c35d958366d9d7b29"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t cy_ota_storage_context_t::validate_after_reboot</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>0 = OTA will set upgrade image as permanent before reboot. </p>
<p>1 = The application should validate and set the upgrade image as the permanent image after reboot. </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>Over The Air (OTA) Update Library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
</body>
</html>
